home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dgesvd.z / dgesvd
Encoding:
Text File  |  2002-10-03  |  7.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. DDDDGGGGEEEESSSSVVVVDDDD((((3333SSSS))))                                                          DDDDGGGGEEEESSSSVVVVDDDD((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DGESVD - compute the singular value decomposition (SVD) of a real M-by-N
  10.      matrix A, optionally computing the left and/or right singular vectors
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DGESVD( JOBU, JOBVT, M, N, A, LDA, S, U, LDU, VT, LDVT, WORK,
  14.                         LWORK, INFO )
  15.  
  16.          CHARACTER      JOBU, JOBVT
  17.  
  18.          INTEGER        INFO, LDA, LDU, LDVT, LWORK, M, N
  19.  
  20.          DOUBLE         PRECISION A( LDA, * ), S( * ), U( LDU, * ), VT( LDVT,
  21.                         * ), WORK( * )
  22.  
  23. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  24.      These routines are part of the SCSL Scientific Library and can be loaded
  25.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  26.      directs the linker to use the multi-processor version of the library.
  27.  
  28.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  29.      4 bytes (32 bits). Another version of SCSL is available in which integers
  30.      are 8 bytes (64 bits).  This version allows the user access to larger
  31.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  32.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  33.      only one of the two versions; 4-byte integer and 8-byte integer library
  34.      calls cannot be mixed.
  35.  
  36. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  37.      DGESVD computes the singular value decomposition (SVD) of a real M-by-N
  38.      matrix A, optionally computing the left and/or right singular vectors.
  39.      The SVD is written
  40.           A = U * SIGMA * transpose(V)
  41.  
  42.      where SIGMA is an M-by-N matrix which is zero except for its min(m,n)
  43.      diagonal elements, U is an M-by-M orthogonal matrix, and V is an N-by-N
  44.      orthogonal matrix.  The diagonal elements of SIGMA are the singular
  45.      values of A; they are real and non-negative, and are returned in
  46.      descending order.  The first min(m,n) columns of U and V are the left and
  47.      right singular vectors of A.
  48.  
  49.      Note that the routine returns V**T, not V.
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      JOBU    (input) CHARACTER*1
  54.              Specifies options for computing all or part of the matrix U:
  55.              = 'A':  all M columns of U are returned in array U:
  56.              = 'S':  the first min(m,n) columns of U (the left singular
  57.              vectors) are returned in the array U; = 'O':  the first min(m,n)
  58.              columns of U (the left singular vectors) are overwritten on the
  59.              array A; = 'N':  no columns of U (no left singular vectors) are
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDGGGGEEEESSSSVVVVDDDD((((3333SSSS))))                                                          DDDDGGGGEEEESSSSVVVVDDDD((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              computed.
  75.  
  76.      JOBVT   (input) CHARACTER*1
  77.              Specifies options for computing all or part of the matrix V**T:
  78.              = 'A':  all N rows of V**T are returned in the array VT;
  79.              = 'S':  the first min(m,n) rows of V**T (the right singular
  80.              vectors) are returned in the array VT; = 'O':  the first min(m,n)
  81.              rows of V**T (the right singular vectors) are overwritten on the
  82.              array A; = 'N':  no rows of V**T (no right singular vectors) are
  83.              computed.
  84.  
  85.              JOBVT and JOBU cannot both be 'O'.
  86.  
  87.      M       (input) INTEGER
  88.              The number of rows of the input matrix A.  M >= 0.
  89.  
  90.      N       (input) INTEGER
  91.              The number of columns of the input matrix A.  N >= 0.
  92.  
  93.      A       (input/output) DOUBLE PRECISION array, dimension (LDA,N)
  94.              On entry, the M-by-N matrix A.  On exit, if JOBU = 'O',  A is
  95.              overwritten with the first min(m,n) columns of U (the left
  96.              singular vectors, stored columnwise); if JOBVT = 'O', A is
  97.              overwritten with the first min(m,n) rows of V**T (the right
  98.              singular vectors, stored rowwise); if JOBU .ne. 'O' and JOBVT
  99.              .ne. 'O', the contents of A are destroyed.
  100.  
  101.      LDA     (input) INTEGER
  102.              The leading dimension of the array A.  LDA >= max(1,M).
  103.  
  104.      S       (output) DOUBLE PRECISION array, dimension (min(M,N))
  105.              The singular values of A, sorted so that S(i) >= S(i+1).
  106.  
  107.      U       (output) DOUBLE PRECISION array, dimension (LDU,UCOL)
  108.              (LDU,M) if JOBU = 'A' or (LDU,min(M,N)) if JOBU = 'S'.  If JOBU =
  109.              'A', U contains the M-by-M orthogonal matrix U; if JOBU = 'S', U
  110.              contains the first min(m,n) columns of U (the left singular
  111.              vectors, stored columnwise); if JOBU = 'N' or 'O', U is not
  112.              referenced.
  113.  
  114.      LDU     (input) INTEGER
  115.              The leading dimension of the array U.  LDU >= 1; if JOBU = 'S' or
  116.              'A', LDU >= M.
  117.  
  118.      VT      (output) DOUBLE PRECISION array, dimension (LDVT,N)
  119.              If JOBVT = 'A', VT contains the N-by-N orthogonal matrix V**T; if
  120.              JOBVT = 'S', VT contains the first min(m,n) rows of V**T (the
  121.              right singular vectors, stored rowwise); if JOBVT = 'N' or 'O',
  122.              VT is not referenced.
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDGGGGEEEESSSSVVVVDDDD((((3333SSSS))))                                                          DDDDGGGGEEEESSSSVVVVDDDD((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LDVT    (input) INTEGER
  141.              The leading dimension of the array VT.  LDVT >= 1; if JOBVT =
  142.              'A', LDVT >= N; if JOBVT = 'S', LDVT >= min(M,N).
  143.  
  144.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  145.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK; if INFO
  146.              > 0, WORK(2:MIN(M,N)) contains the unconverged superdiagonal
  147.              elements of an upper bidiagonal matrix B whose diagonal is in S
  148.              (not necessarily sorted). B satisfies A = U * B * VT, so it has
  149.              the same singular values as A, and singular vectors related by U
  150.              and VT.
  151.  
  152.      LWORK   (input) INTEGER
  153.              The dimension of the array WORK. LWORK >= 1.  LWORK >=
  154.              MAX(3*MIN(M,N)+MAX(M,N),5*MIN(M,N)).  For good performance, LWORK
  155.              should generally be larger.
  156.  
  157.              If LWORK = -1, then a workspace query is assumed; the routine
  158.              only calculates the optimal size of the WORK array, returns this
  159.              value as the first entry of the WORK array, and no error message
  160.              related to LWORK is issued by XERBLA.
  161.  
  162.      INFO    (output) INTEGER
  163.              = 0:  successful exit.
  164.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  165.              > 0:  if DBDSQR did not converge, INFO specifies how many
  166.              superdiagonals of an intermediate bidiagonal form B did not
  167.              converge to zero. See the description of WORK above for details.
  168.  
  169. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  170.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  171.  
  172.      This man page is available only online.
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.